.\" Manual page for ukui-session
.\"
.\" This is free software; you may redistribute it and/or modify
.\" it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2,
.\" or (at your option) any later version.
.\"
.\" This is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License along
.\" with this program; if not, write to the Free Software Foundation, Inc.,
.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
.\"
.\" (C) 2000 Miguel de Icaza (miguel@helixcode.com)
.\" (C) 2009-2010 Vincent Untz (vuntz@gnome.org)
.\" (C) 2023, KylinSoft Co., Ltd.
.\"
.TH UKUI-SESSION 1 "11 February 2023" "UKUI Desktop Environment"
.\" Please adjust this date when revising the manpage.
.\"
.SH "NAME"
ukui-session \- Start the UKUI Desktop Environment.
.SH "SYNOPSIS"
.B ukui-session [OPTIONS]
.SH "DESCRIPTION"
The \fBukui-session\fP program starts up the UKUI desktop environment. This command is typically executed by your Login/Display Manager (like GDM, LXDM, XDM, SLiM, or from your X startup scripts like .xinitrc). It will load either your saved session, or it will provide a default session for the user as defined by the system administrator (or the default UKUI installation on your system).
.PP
The default session is defined in the dconf keys under
.BI / org / ukui / desktop / session /
.br
When saving a session, \fBukui-session\fP saves the currently running applications in the \fB~/.config/ukui-session/saved-session\fP directory of the users /home.
.PP
\fBukui-session\fP is an X11 session manager. It can manage UKUI applications as well as any other X11 SM compliant ones.

.SH "OPTIONS"
.SS The following options are supported:
.TP
\fB\-a, \-\-autostart=DIR\fR
Start all applications defined in "\fBDIR\fP", instead of starting the applications defined in 
.BI / org / ukui / desktop / session / default\-session
.br
Multiple \fB\-\-autostart\fP options can be passed.
.TP
\fB\-f, \-\-failsafe\fR
Run in fail-safe mode. User-specified applications will not be started.
.TP
\fB\-\-debug\fR
Enable debugging code.
.TP
\fB\-\-display=DISPLAY\fR
X display to use.
.TP
\fB\-\-version\fR
Output version information and exit.
.TP
\fB\-?, \-h, \-\-help\fR
Print standard command line options.
.TP
\fB\-\-help\-all\fR
Print all command line options.

.SH "ENVIRONMENT"
.SS \fBukui-session\fP sets several environment variables for the use of its child processes:
.PP
.B "SESSION_MANAGER"
.IP
This variable is used by session-manager aware clients to contact ukui-session.
.PP
.B "DISPLAY"
.IP
This variable is set to the X display being used by \fBukui-session\fP. Note that if the \-\-display option is used this might be different from the setting of the environment variable when ukui-session is invoked.

.SH "FILES"
.PP
.nf
.B ~/.config/autostart
.B /usr/share/autostart
.B /usr/share/ukui/autostart
.fi
.IP
The applications defined in the above directories will be started on login. \fBukui-session-properties(1)\fP can be used to easily configure them.
.PP
.B ~/.config/ukui-session/saved-session
.IP
This directory contains the list of applications of the saved session.
.SH "BUGS"
.SS Should you encounter any bugs, they may be reported at: 
https://github.com/ukui/ukui-session-manager/issues
.SH "AUTHORS"
.SS This Manual page was originally written for gnome-session by:
.nf
Miguel de Icaza <miguel@helixcode.com> (2000)
Vincent Untz <vuntz@gnome.org> (2009-2010)
.fi
.SS It has been updated for the MATE Desktop Environment by:
Adam Erdman <hekel@archlinux.info> (2014)
.SS It has been updated for the UKUI Desktop Environment by:
yilei <yilei@kylinos.cn> (2016)
.SH "SEE ALSO"
.SS Further information may also be available at: http://wiki.ukui.org/
.P
.BR ukui-session-properties(1),
.BR ukui-session-save(1),
.BR ukui-wm(1)
